home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmVaCreateSimpleOptionMenu.z / XmVaCreateSimpleOptionMenu
Text File  |  1998-10-30  |  12KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu - A RowColumn widget convenience
  10.           creation function
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/RowColumn.h>
  14.           WWWWiiiiddddggggeeeetttt XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(
  15.           WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt,
  16.           SSSSttttrrrriiiinnnngggg nnnnaaaammmmeeee,
  17.           XXXXmmmmSSSSttttrrrriiiinnnngggg ooooppppttttiiiioooonnnn____llllaaaabbbbeeeellll,
  18.           KKKKeeeeyyyySSSSyyyymmmm ooooppppttttiiiioooonnnn____mmmmnnnneeeemmmmoooonnnniiiicccc,
  19.           iiiinnnntttt bbbbuuuuttttttttoooonnnn____sssseeeetttt,
  20.           XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc ccccaaaallllllllbbbbaaaacccckkkk);
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents Motif 2.1.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu creates an instance of a
  27.           RowColumn widget of type XXXXmmmmMMMMEEEENNNNUUUU____OOOOPPPPTTTTIIIIOOOONNNN and returns the
  28.           associated widget ID.  This routine uses the ANSI C
  29.           variable-length argument list (_v_a_r_a_r_g_s) calling convention.
  30.  
  31.           This routine creates an OptionMenu and its Pulldown submenu
  32.           containing PushButtonGadget or CascadeButtonGadget children.
  33.           The name of each button is bbbbuuuuttttttttoooonnnn_____n, where _n is an integer
  34.           from 0 (zero) to the number of buttons in the menu minus 1.
  35.           The name of each separator is sssseeeeppppaaaarrrraaaattttoooorrrr_____n, where _n is an
  36.           integer from 0 (zero) to the number of separators in the
  37.           menu minus 1.  Buttons and separators are named and created
  38.           in the order in which they are specified in the variable
  39.           portion of the argument list.
  40.  
  41.           _p_a_r_e_n_t    Specifies the parent widget ID
  42.  
  43.           _n_a_m_e      Specifies the name of the created widget
  44.  
  45.           _o_p_t_i_o_n__l_a_b_e_l
  46.                     Specifies the label string to be used on the left
  47.                     side of the OptionMenu.
  48.  
  49.           _o_p_t_i_o_n__m_n_e_m_o_n_i_c
  50.                     Specifies a keysym for a key that, when pressed by
  51.                     the user, posts the associated Pulldown menu pane.
  52.  
  53.           _b_u_t_t_o_n__s_e_t
  54.                     Specifies which PushButtonGadget is initially set.
  55.                     The value is the integer _n that corresponds to the
  56.                     _nth PushButtonGadget specified in the variable
  57.                     portion of the argument list.  Only a
  58.                     PushButtonGadget can be set, and only
  59.                     PushButtonGadgets are counted in determining the
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     integer _n.  The first PushButtonGadget is number 0
  75.                     (zero).
  76.  
  77.           _c_a_l_l_b_a_c_k  Specifies a callback procedure to be called when a
  78.                     button is activated.  This callback function is
  79.                     added to each button after creation as the
  80.                     button's XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  The callback
  81.                     function is called when a button is activated, and
  82.                     the button number is returned in the _c_l_i_e_n_t__d_a_t_a
  83.                     field.
  84.  
  85.           The variable portion of the argument list consists of groups
  86.           of arguments.  The first argument in each group is a
  87.           constant or a string and determines which arguments follow
  88.           in that group.  The last argument in the list must be NULL.
  89.           Following are the possible first arguments in each group of
  90.           _v_a_r_a_r_g_s:
  91.  
  92.           XXXXmmmmVVVVaaaaPPPPUUUUSSSSHHHHBBBBUUUUTTTTTTTTOOOONNNN
  93.                     This is followed by four additional arguments. The
  94.                     set specifies one button in the OptionMenu's
  95.                     Pulldown submenu and some of its resource values.
  96.                     The button created is a PushButtonGadget.
  97.                     Following are the additional four arguments, in
  98.                     order:
  99.  
  100.                     _l_a_b_e_l     The label string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  101.  
  102.                     _m_n_e_m_o_n_i_c  The mnemonic, of type KKKKeeeeyyyySSSSyyyymmmm
  103.  
  104.                     _a_c_c_e_l_e_r_a_t_o_r
  105.                               The accelerator, of type SSSSttttrrrriiiinnnngggg
  106.  
  107.                     _a_c_c_e_l_e_r_a_t_o_r__t_e_x_t
  108.                               The accelerator text, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  109.  
  110.           XXXXmmmmVVVVaaaaSSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  111.                     This is followed by no additional arguments. It
  112.                     specifies one separator in the OptionMenu's
  113.                     Pulldown submenu.
  114.  
  115.           XXXXmmmmVVVVaaaaDDDDOOOOUUUUBBBBLLLLEEEE____SSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  116.                     This is followed by no additional arguments. It
  117.                     specifies one separator in the OptionMenu's
  118.                     Pulldown submenu. The separator type is
  119.                     XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE.
  120.  
  121.           _r_e_s_o_u_r_c_e__n_a_m_e
  122.                     This is followed by one additional argument, the
  123.                     value of the resource, of type _X_t_A_r_g_V_a_l. The pair
  124.                     specifies a resource and its value for the
  125.                     Pulldown submenu.
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XXXXttttVVVVaaaaTTTTyyyyppppeeeeddddAAAArrrrgggg
  141.                     This is followed by four additional arguments. The
  142.                     set specifies a resource and its value for the
  143.                     Pulldown submenu. A resource type conversion is
  144.                     performed if necessary. Following are the
  145.                     additional four arguments, in order:
  146.  
  147.                     _n_a_m_e      The resource name, of type SSSSttttrrrriiiinnnngggg
  148.  
  149.                     _t_y_p_e      The type of the resource value supplied,
  150.                               of type SSSSttttrrrriiiinnnngggg
  151.  
  152.                     _v_a_l_u_e     The resource value (or a pointer to the
  153.                               resource value, depending on the type
  154.                               and size of the value), of type _X_t_A_r_g_V_a_l
  155.  
  156.                     _s_i_z_e      The size of the resource value in bytes,
  157.                               of type _i_n_t
  158.  
  159.           XXXXttttVVVVaaaaNNNNeeeesssstttteeeeddddLLLLiiiisssstttt
  160.                     This is followed by one additional argument of
  161.                     type _X_t_V_a_r_A_r_g_s_L_i_s_t.  This argument is a nested
  162.                     list of _v_a_r_a_r_g_s returned by XXXXttttVVVVaaaaCCCCrrrreeeeaaaatttteeeeAAAArrrrggggssssLLLLiiiisssstttt.
  163.  
  164.           The user can specify resources in a resource file for the
  165.           automatically created widgets and gadgets of an OptionMenu.
  166.           The following list identifies the names of these widgets (or
  167.           gadgets) and the associated OptionMenu areas:
  168.  
  169.           Option Menu Label Gadget
  170.                     OOOOppppttttiiiioooonnnnLLLLaaaabbbbeeeellll
  171.  
  172.           Option Menu Cascade Button
  173.                     OOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnn
  174.  
  175.           For more information on variable-length argument lists, see
  176.           the X Toolkit Intrinsics documentation.
  177.  
  178.           A number of resources exist specifically for use with this
  179.           and other simple menu creation routines.  For a complete
  180.           definition of RowColumn and its associated resources, see
  181.           XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3).
  182.  
  183.      RRRREEEETTTTUUUURRRRNNNN
  184.           Returns the RowColumn widget ID.
  185.  
  186.      RRRREEEELLLLAAAATTTTEEEEDDDD
  187.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3),
  188.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(3), and XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3).
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.